home *** CD-ROM | disk | FTP | other *** search
/ Amiga Collections: Panorama / Panorama - Disk 19D (1987-07-22)(Pacific North-West Amigas Club)[WB].zip / Panorama - Disk 19D (1987-07-22)(Pacific North-West Amigas Club)[WB].adf / Zoo1.42a / zoo.man < prev    next >
Text File  |  1987-07-07  |  18KB  |  529 lines
  1.  
  2.  
  3.  
  4. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      zoo - manipulate archives of files in compressed form
  10.  
  11. SYNOPSIS
  12.      zoo {acDehlLPTuUvx}[cdEfnMNoOpPquv1:./@] archive [file] ...
  13.      zoo -command archive [file] ...
  14.      zoo h
  15.  
  16. DESCRIPTION
  17.      Zoo is used to create and maintain collections of files in
  18.      compressed form.  It uses a Lempel-Ziv compression algorithm
  19.      that gives space savings in the range of 20% to 80% depend-
  20.      ing on the type of file data.
  21.  
  22.      The command zoo h gives summary of commands.
  23.  
  24.      Zoo will not add an archive to itself, nor add the archive's
  25.      backup (with `.bak' extension to the filename) to the
  26.      archive.
  27.  
  28.      Zoo has two types of commands:  Expert commands, which con-
  29.      sist of one command letter followed by zero or more modifier
  30.      characters, and Novice commands, which consist of a hyphen
  31.      (`-') followed by a command word that may be abbreviated.
  32.      Expert commands are case-sensitive but Novice commands are
  33.      not.
  34.  
  35.      When zoo adds a file to an existing archive, it marks as
  36.      deleted any already-archived file with the same name (any
  37.      directory prefix being ignored in this comparison).  Deleted
  38.      files may be later undeleted. Archives may be packed to
  39.      recover space occupied by deleted files.
  40.  
  41.      All commands assume that the archive name ends with the
  42.      characters `.zoo' unless a different extension is supplied.
  43.  
  44.      Novice commands
  45.  
  46.      Novice commands may be abbreviated to a hyphen followed by
  47.      at least one command character.  Each Novice command works
  48.      in two stages. First, the command does its intended work.
  49.      Then, if the result was that one or more files were deleted
  50.      in the specified archive, the archive is packed.  If packing
  51.      occurs, the original unpacked archive is always left behind
  52.      in the current directory, with an extension of `.bak'.  The
  53.      Novice commands are as follows.
  54.  
  55.      -add    Adds the specified files to the archive.
  56.  
  57.      -freshen
  58.           Adds a specified file to the archive if and only if an
  59.           older file by the same name already exists in the
  60.  
  61.  
  62.  
  63. Printed 2/6/87          February 6, 1987                        1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  71.  
  72.  
  73.  
  74.           archive.
  75.  
  76.      -delete
  77.           Deletes the specified files from the archive.
  78.  
  79.      -update
  80.           Adds a specified file to the archive either:  if an
  81.           older file by the same name already exists in the
  82.           archive or:  if a file by the same name does not
  83.           already exist in the archive.
  84.  
  85.      -extract
  86.           Extracts the specified files from the archive.  If no
  87.           file is specified all files are extracted.
  88.  
  89.      -move
  90.           Equivalent to -add except that source files are deleted
  91.           after addition.
  92.  
  93.      -print
  94.           Equivalent to -extract except that extracted data are
  95.           sent to standard output.
  96.  
  97.      -list
  98.           Gives information about the specified archived files
  99.           including any attached comments.  If no files are
  100.           specified all files are listed.  Deleted files are not
  101.           listed.
  102.  
  103.      -test
  104.           Equivalent to -extract except that the extracted data
  105.           are not saved but any errors encountered are reported.
  106.  
  107.      -comment
  108.           Allows the user to add or update comments attached to
  109.           archived files.  When prompted, the user may:  type a
  110.           carriage return to skip the file, leaving any current
  111.           comment unchanged;  or type a (possibly null) comment
  112.           of up to 65,535 characters terminated by `/end' (case-
  113.           insensitive) on a separate line;  or type the end-of-
  114.           file character (normally control D) to skip all remain-
  115.           ing files.
  116.  
  117.      -delete
  118.           Deletes the specified files.
  119.  
  120.      The correspondence between Novice and Expert commands is as
  121.      follows.
  122.  
  123.      Novice                                                Equivalent
  124.      Command    Description                                Expert Command
  125.      -------    -----------                                --------------
  126.  
  127.  
  128.  
  129. Printed 2/6/87          February 6, 1987                        2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  137.  
  138.  
  139.  
  140.      -add       add files to archive                         aP
  141.      -extract   extract files from archive                   x
  142.      -move      move files to archive                        aMP
  143.      -test      test archive integrity                       xNd
  144.      -print     extract files and send to standard output    xp
  145.      -delete    delete files from archive                    DP
  146.      -list      list information about archived files        v
  147.      -update    update archive by adding new or newer files  aunP
  148.      -freshen   freshen archive by adding newer files        auP
  149.      -comment   allows user to attach comments to files      c
  150.  
  151.      Expert commands
  152.  
  153.      The general format of expert commands is:
  154.  
  155.      zoo {acDehlPTuUvx}[cdEfnMNoOpPquv1:./@] archive [file] ...
  156.  
  157.      The characters enclosed within {} are commands.  Choose any
  158.      one of these.  The characters enclosed within [] just to the
  159.      right of the {} are modifiers and zero or more of these may
  160.      immediately follow the command character.  All combinations
  161.      of command and modifier characters may not be valid.
  162.  
  163.      Files are added to an archive with the command:
  164.  
  165.      zoo {au}[cfMnPqu:] archive file ...
  166.  
  167.      Command characters are:
  168.  
  169.      a    Add each specified file to archive.  Any already-
  170.           archived file with the same name is marked as deleted.
  171.  
  172.      u    Do an update of the archive.  A specified file is added
  173.           to the archive only if a copy of it is already in the
  174.           archive and the copy being added is newer than the copy
  175.           already in the archive.
  176.  
  177.      The following modifiers are specific to these commands.
  178.  
  179.      M    Move files to archive.  This makes zoo unlink the ori-
  180.           ginal files after they have been added to the archive.
  181.           Files are unlinked after addition of files to the
  182.           archive is complete, and after any requested packing of
  183.           the archive has been done, and only if zoo detected no
  184.           errors.
  185.  
  186.      n    Add new files only.  A specified file is added only if
  187.           it isn't already in the archive.
  188.  
  189.      P    Pack archive after files have been added.
  190.  
  191.  
  192.  
  193.  
  194.  
  195. Printed 2/6/87          February 6, 1987                        3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  203.  
  204.  
  205.  
  206.      u    Applied to the a command, this modifier makes it behave
  207.           identically to the u command.
  208.  
  209.      The combination of the n modifier with the u modifier or u
  210.      command causes addition of a file to the archive either if
  211.      the file is not already in the archive, or if the file is
  212.      already in the archive but the archived copy is older than
  213.      the copy being added.
  214.  
  215.      :    Do not store directory names.  In the absence of this
  216.           modifier zoo stores the full pathname of each archived
  217.           file.
  218.  
  219.      Files are extracted from an archive with the command:
  220.  
  221.      zoo {ex}[dNoOpq./@] archive [file] ...
  222.  
  223.      The e and x commands are synonymous.  If no file was speci-
  224.      fied, all files are extracted from the archive.  All
  225.      extracted files go into the current directory.
  226.  
  227.      The following modifiers are specific to the e and x com-
  228.      mands:
  229.  
  230.      N    Do not save extracted data but report any errors
  231.           encountered.
  232.  
  233.      O    Overwrite files.  Normally, if a file being extracted
  234.           would overwrite an already-existing file of the same
  235.           name, zoo asks you if you really want to overwrite it.
  236.           You may answer the question with `y', which means yes,
  237.           overwrite; or `n', which means no, don't overwrite; or
  238.           `a', which means assume the answer is `y' for this and
  239.           all subsequent files.  The O modifier makes zoo assume
  240.           that files may always be overwritten.
  241.  
  242.           The O, N, and p modifiers are mutually exclusive.
  243.  
  244.      o    This is equivalent to the O modifier if and only if it
  245.           is given at least twice.  It is otherwise ignored.
  246.  
  247.      p    Pipe extracted data to standard output.  Error messages
  248.           are piped to standard output as well.  However, if a
  249.           bad CRC is detected, an error message is sent both to
  250.           standard error and to standard output.
  251.  
  252.      /    Extract to original pathname.  Any needed directories
  253.           must already exist.  In the absence of this modifier
  254.           all files are extracted into the current directory.  If
  255.           this modifier is doubled as // needed directories need
  256.           not exist and are created if necessary.
  257.  
  258.  
  259.  
  260.  
  261. Printed 2/6/87          February 6, 1987                        4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  269.  
  270.  
  271.  
  272.      .    In conjunction with / or // this modifier causes any
  273.           pathname beginning with `/' to be interpreted relative
  274.           to the current directory, resulting in the possible
  275.           creation of a subtree rooted at the current directory.
  276.  
  277.      Archived files are listed with the command:
  278.  
  279.      zoo {lLv}[adfv@] archive[.zoo] [file] ...
  280.  
  281.      l    Information presented includes the date and time of
  282.           each file, its original and current (compressed) sizes,
  283.           and the percentage size decrease due to compression
  284.           (labelled CF or compression factor).  If no filename is
  285.           supplied all files are listed except deleted files.
  286.  
  287.      L    This is identical to the l command except that all sup-
  288.           plied arguments must be archives and the contents of
  289.           each are listed.
  290.  
  291.      v    This causes a verbose listing, which additionally shows
  292.           any comment attached to each file.  Using the v modif-
  293.           ier with the l command has the same effect.
  294.  
  295.      The following modifier is specific to the archive list com-
  296.      mands:
  297.  
  298.      a    This gives a single-line format containing both each
  299.           filename and the name of the archive, sorted by archive
  300.           name.  It is especially useful with the L command,
  301.           since the result can be further sorted on any field to
  302.           give a master listing of the entire contents of a set
  303.           of archives.
  304.  
  305.      Files may be deleted and undeleted from an archive with the
  306.      following commands:
  307.  
  308.      zoo {DU}[Pq1] archive file ...
  309.  
  310.      The D command deletes the specified files and the U command
  311.      undeletes the specified files.  The 1 modifier (the digit
  312.      one, not the letter ell) forces deletion or undeletion of at
  313.      most one file.  If multiple instances of the same file exist
  314.      in an archive, use of the 1 modifier may allow selective
  315.      extraction of one of these.
  316.  
  317.      Comments may be added to an archive with the command:
  318.  
  319.      zoo c archive
  320.  
  321.      This behaves identically to the -comment command.
  322.  
  323.  
  324.  
  325.  
  326.  
  327. Printed 2/6/87          February 6, 1987                        5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  335.  
  336.  
  337.  
  338.      The timestamp of an archive may be adjusted with the com-
  339.      mand:
  340.  
  341.      zoo T[q] archive
  342.  
  343.      Zoo normally attempts to maintain the timestamp of an
  344.      archive to reflect the age of the newest file stored in it.
  345.      Should the timestamp ever be incorrect it can be fixed with
  346.      the T command.
  347.  
  348.      An archive may be packed with the command:
  349.  
  350.      zoo P[EPq] archive
  351.  
  352.      If the backup copy of the archive already exists, zoo will
  353.      refuse to pack the archive unless the P modifier is also
  354.      given.  The E modifier causes zoo not to save a backup copy
  355.      of the original archive after packing.  A unique temporary
  356.      file in the current directory is used to initially hold the
  357.      packed archive.  This file will be left behind if packing is
  358.      interrupted or if for some reason this file cannot be
  359.      renamed to the name of the original archive when packing is
  360.      complete.
  361.  
  362.      Packing removes any garbage data appended to an archive
  363.      because of Xmodem file transfer and also recovers spaced
  364.      used by comments that were replaced.
  365.  
  366.      General modifiers
  367.  
  368.      The following modifiers are applicable to several commands:
  369.  
  370.      c    Applied to the a and u commands, this causes the user
  371.           to be prompted for a comment for each file added to the
  372.           archive.  If the file being added has replaced a file
  373.           already in the archive, any comment attached to the
  374.           replaced file is shown to the user and becomes attached
  375.           to the newly-added file unless the user changes it.
  376.           Possible user responses are as described for the -com-
  377.           ment command.  Applied to the archive list command l,
  378.           the c modifier causes attached comments to archived
  379.           files to be listed.
  380.  
  381.      d    Most commands that act on an archive act only on files
  382.           that are not deleted.  The d modifier makes commands
  383.           act on both normal and deleted files.  If doubled as
  384.           dd, this modifier forces selection only of deleted
  385.           files.
  386.  
  387.      f    Applied to the a and u commands, the f modifier causes
  388.           fast archiving by adding files without compression.
  389.           Applied to l it causes a fast listing of files in a
  390.  
  391.  
  392.  
  393. Printed 2/6/87          February 6, 1987                        6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  401.  
  402.  
  403.  
  404.           multicolumn format.
  405.  
  406.      q    Be quiet.  Normally zoo lists the name of each file and
  407.           what action it is performing.  The q modifier
  408.           suppresses this.  When files are being extracted to
  409.           standard output, the q modifier suppresses the header
  410.           preceding each file.
  411.  
  412.           Error messages are never suppressed.
  413.  
  414.      @    Extract or list beginning at position n, where n is a
  415.           decimal number following the @ sign without any inter-
  416.           vening spaces.  This may be used to recover data from a
  417.           damaged archive by skipping the damaged part.  The
  418.           number specified must be the position within the
  419.           archive of an undamaged directory entry.  This position
  420.           is usually obtained from fiz(1).
  421.  
  422.      Wildcard handling
  423.  
  424.      The shell normally expands wildcards to a list of matching
  425.      files.  Wildcards that are meant to match files within an
  426.      archive must therefore be escaped or quoted.  The wildcard
  427.      syntax interpreted by zoo is limited to the following char-
  428.      acters.
  429.  
  430.      *    Matches any sequence of zero or more characters not
  431.           containing a dot; however, see below.
  432.  
  433.      ?    Matches any single character except a dot;  however,
  434.           see below.
  435.  
  436.           Arbitrary combinations of ``*'' and ``?'' are allowed.
  437.  
  438.      /    If a supplied pattern contains a slash anywhere in it,
  439.           then the slash separating any directory prefix from the
  440.           filename must be matched explicitly.  As a special
  441.           case, if a supplied pattern contains no slashes, it is
  442.           treated as if it contained a leading `**/' and the
  443.           match is therefore selective only on the filename.
  444.  
  445.      .    Normally required to match a dot in any filename.  How-
  446.           ever, if a supplied pattern contains a double asterisk
  447.           `**', the dot need not be explicitly supplied.  Thus
  448.           `zoo.c' will be matched by `*.c' and by `**c' but not
  449.           by `*c'.
  450.  
  451.           As a special case, the wildcard sequence ``*.*''
  452.           matches every sequence of trailing characters in a
  453.           filename including those that do not contain a dot.
  454.  
  455.  
  456.  
  457.  
  458.  
  459. Printed 2/6/87          February 6, 1987                        7
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. ZOO(1)              **IX Programmer's Manual               ZOO(1)
  467.  
  468.  
  469.  
  470.      c-c  Two characters separated by a hyphen specify a charac-
  471.           ter range.  All filenames beginning with those charac-
  472.           ters will match.  The character range may be specified
  473.           only by itself or preceded by a directory name.  It is
  474.           not specially interpreted if it is part of a filename.
  475.  
  476. FILES
  477.      xXXXXXX - temporary file used during packing
  478.      archive_name.bak - backup of archive
  479.  
  480. SEE ALSO
  481.      compress(1), fiz(1)
  482.  
  483. BUGS
  484.      Standard input cannot be archived nor can a created archive
  485.      be sent to standard output.  Spurious error messages may
  486.      appear if the filename of an archive is too long.  The
  487.      filename `+' is reserved for future use and will not be
  488.      recognized if explicitly specified; however, it may be
  489.      matched with a pattern.
  490.  
  491. DIAGNOSTICS
  492.      Error messages are intended to be self-explanatory and are
  493.      divided into three categories.  WARNINGS are intended to
  494.      inform the user of an unusual situation, such as a CRC error
  495.      during extraction, or -freshening of an archive containing a
  496.      file newer than one specified on the command line.  ERRORS
  497.      are fatal to one file, but execution continues with the next
  498.      file if any.  FATAL errors cause execution to be aborted.
  499.      The occurrence of any of these causes an exit status of 1.
  500.      Normal termination without any errors gives an exit status
  501.      of 0.
  502.  
  503. FUTURE DIRECTIONS
  504.      A revised version of zoo is in the works which will allow
  505.      numbering of multiple versions of a file and automatically
  506.      perform end-of-line conversion for text files moved between
  507.      dissimilar systems.  It will be upward and downward compati-
  508.      ble with existing versions of zoo.
  509.  
  510. AUTHOR
  511.      Rahul Dhesi
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525. Printed 2/6/87          February 6, 1987                        8
  526.  
  527.  
  528.  
  529.